<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.dailyprojectdata.resource.snapshot;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Collections;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.HashSet;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Iterator;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.List;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.Set;<a name="line.7"></a>
<FONT color="green">008</FONT>    import javax.xml.datatype.DatatypeConstants;<a name="line.8"></a>
<FONT color="green">009</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>    import org.hackystat.sensorbase.client.SensorBaseClient;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.sensorbase.client.SensorBaseClientException;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorData;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorDataIndex;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorDataRef;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.utilities.time.period.Day;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.utilities.tstamp.Tstamp;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    /**<a name="line.19"></a>
<FONT color="green">020</FONT>     * This class is deprecated, you should use the SensorBase REST API to retrieve snapshots. <a name="line.20"></a>
<FONT color="green">021</FONT>     * <a name="line.21"></a>
<FONT color="green">022</FONT>     * SensorDataSnapshot provides a generic means to retrieve and return the set of SensorData of a<a name="line.22"></a>
<FONT color="green">023</FONT>     * given SDT with the most recent 'runtime' value. It does this by retrieving "buckets" of data for<a name="line.23"></a>
<FONT color="green">024</FONT>     * a given interval size (defaulting to 30 minutes), starting at 11:30pm on the given day and<a name="line.24"></a>
<FONT color="green">025</FONT>     * working backward until a complete 'snapshot' has been achieved.<a name="line.25"></a>
<FONT color="green">026</FONT>     * <a name="line.26"></a>
<FONT color="green">027</FONT>     * The Snapshot algorithm is based upon a number of assumptions that may or may not be true in<a name="line.27"></a>
<FONT color="green">028</FONT>     * practice:<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;ul&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;li&gt; When sending data with a given runtime, that "batch" will provide all of the data required<a name="line.30"></a>
<FONT color="green">031</FONT>     * for all projects. The snapshot algorithm does not provide any way to "combine" data from multiple<a name="line.31"></a>
<FONT color="green">032</FONT>     * runs with different timestamps, each for a separate resource in the project.<a name="line.32"></a>
<FONT color="green">033</FONT>     * <a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;li&gt; This algorithm depends upon the runtime and tstamp fields being "covariant". More precisely,<a name="line.34"></a>
<FONT color="green">035</FONT>     * given two SensorData instances for a given day called A and B, if runtime(A) is greater than<a name="line.35"></a>
<FONT color="green">036</FONT>     * runtime(B), then tstamp(A) must also be greater than tstamp(B). This assumption enables us to<a name="line.36"></a>
<FONT color="green">037</FONT>     * retrieve SensorData by timestamp in reverse chronological order, and stop as soon as we have a<a name="line.37"></a>
<FONT color="green">038</FONT>     * complete snapshot of runtime values.<a name="line.38"></a>
<FONT color="green">039</FONT>     * <a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;li&gt; Finally, this Snapshot is based upon the combined SensorData from all users in a Project.<a name="line.40"></a>
<FONT color="green">041</FONT>     * Thus, results can be unpredictable when SensorData from multiple users (with overlapping<a name="line.41"></a>
<FONT color="green">042</FONT>     * timestamps) is sent at around the same time.<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;/ul&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * <a name="line.44"></a>
<FONT color="green">045</FONT>     * An alternative algorithm would return a data structure that provides a single entry for every<a name="line.45"></a>
<FONT color="green">046</FONT>     * resource found across all of the users, but using only the latest runtime when multiple entries<a name="line.46"></a>
<FONT color="green">047</FONT>     * for a single resource exist. The problem with this approach is that if a resource is deleted<a name="line.47"></a>
<FONT color="green">048</FONT>     * during a day, it will still be in the snapshot. This can cause bad data when a major refactoring<a name="line.48"></a>
<FONT color="green">049</FONT>     * occurs, resulting in many resources being renamed. In this case, many resources will be<a name="line.49"></a>
<FONT color="green">050</FONT>     * represented twice in the resulting snapshot--once with their old name and once with their new<a name="line.50"></a>
<FONT color="green">051</FONT>     * name.<a name="line.51"></a>
<FONT color="green">052</FONT>     * <a name="line.52"></a>
<FONT color="green">053</FONT>     * A potentially helpful extension would be to enable retrieval of a snapshot using only data that<a name="line.53"></a>
<FONT color="green">054</FONT>     * contains a property called "DailyProjectDataSnapshot" with a user defined value. This would<a name="line.54"></a>
<FONT color="green">055</FONT>     * enable users to define a daily process that creates "complete" versions of project data with a<a name="line.55"></a>
<FONT color="green">056</FONT>     * common runtime. This process could run at any time and all other data from other users,<a name="line.56"></a>
<FONT color="green">057</FONT>     * regardless of their runtime value, would be ignored.<a name="line.57"></a>
<FONT color="green">058</FONT>     * <a name="line.58"></a>
<FONT color="green">059</FONT>     * @author jsakuda<a name="line.59"></a>
<FONT color="green">060</FONT>     */<a name="line.60"></a>
<FONT color="green">061</FONT>    public class SensorDataSnapshot implements Iterable&lt;SensorData&gt; {<a name="line.61"></a>
<FONT color="green">062</FONT>      /** If the snapshot has seen older data. */<a name="line.62"></a>
<FONT color="green">063</FONT>      private boolean seenOlderData = false;<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>      /** The bucket size in minutes. */<a name="line.65"></a>
<FONT color="green">066</FONT>      private int bucketSize = 30;<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>      /** The runtime for this snapshot used to determine if older data has been seen. */<a name="line.68"></a>
<FONT color="green">069</FONT>      private XMLGregorianCalendar snapshotRuntime = null;<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>      /** Holds sensor data associated with the latest snapshot. */<a name="line.71"></a>
<FONT color="green">072</FONT>      private Set&lt;SensorData&gt; latestSnapshot = new HashSet&lt;SensorData&gt;();<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>      /** The last bucket that was processed. */<a name="line.74"></a>
<FONT color="green">075</FONT>      private SnapshotBucket prevBucket = null;<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>      /** Start of the snapshot day. */<a name="line.77"></a>
<FONT color="green">078</FONT>      private XMLGregorianCalendar startOfDay;<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>      /** End of the snapshot day. */<a name="line.80"></a>
<FONT color="green">081</FONT>      private XMLGregorianCalendar endOfDay;<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>      /** The number of buckets retrieved to create the snapshot. */<a name="line.83"></a>
<FONT color="green">084</FONT>      private int bucketsRetrieved = 0;<a name="line.84"></a>
<FONT color="green">085</FONT>      <a name="line.85"></a>
<FONT color="green">086</FONT>      /**<a name="line.86"></a>
<FONT color="green">087</FONT>       * Creates a new snapshot.<a name="line.87"></a>
<FONT color="green">088</FONT>       * <a name="line.88"></a>
<FONT color="green">089</FONT>       * @param client The &lt;code&gt;SensorBaseClient&lt;/code&gt; to be used for querying for<a name="line.89"></a>
<FONT color="green">090</FONT>       *          &lt;code&gt;SensorData&lt;/code&gt;.<a name="line.90"></a>
<FONT color="green">091</FONT>       * @param user The Hackystat user that owns the Project whose data is being retrieved.<a name="line.91"></a>
<FONT color="green">092</FONT>       * @param project The project to obtain data for.<a name="line.92"></a>
<FONT color="green">093</FONT>       * @param sdt The sensor data type to get data for.<a name="line.93"></a>
<FONT color="green">094</FONT>       * @param day The day to get the latest snapshot for.<a name="line.94"></a>
<FONT color="green">095</FONT>       * @throws SensorBaseClientException Thrown if there is an error while communication with the<a name="line.95"></a>
<FONT color="green">096</FONT>       *           sensorbase server.<a name="line.96"></a>
<FONT color="green">097</FONT>       */<a name="line.97"></a>
<FONT color="green">098</FONT>      public SensorDataSnapshot(SensorBaseClient client, String user, String project, String sdt,<a name="line.98"></a>
<FONT color="green">099</FONT>          Day day) throws SensorBaseClientException {<a name="line.99"></a>
<FONT color="green">100</FONT>        this.setUpStartEndDay(day);<a name="line.100"></a>
<FONT color="green">101</FONT>        this.createLatestSnapshot(client, user, project, sdt);<a name="line.101"></a>
<FONT color="green">102</FONT>      }<a name="line.102"></a>
<FONT color="green">103</FONT>    <a name="line.103"></a>
<FONT color="green">104</FONT>      /**<a name="line.104"></a>
<FONT color="green">105</FONT>       * Creates a new snapshot.<a name="line.105"></a>
<FONT color="green">106</FONT>       * <a name="line.106"></a>
<FONT color="green">107</FONT>       * @param client The &lt;code&gt;SensorBaseClient&lt;/code&gt; to be used for querying for<a name="line.107"></a>
<FONT color="green">108</FONT>       *          &lt;code&gt;SensorData&lt;/code&gt;.<a name="line.108"></a>
<FONT color="green">109</FONT>       * @param user The Hackystat user that owns the Project whose data is being retrieved.<a name="line.109"></a>
<FONT color="green">110</FONT>       * @param project The project to obtain data for.<a name="line.110"></a>
<FONT color="green">111</FONT>       * @param sdt The sensor data type to get data for.<a name="line.111"></a>
<FONT color="green">112</FONT>       * @param day The day to get the latest snapshot for.<a name="line.112"></a>
<FONT color="green">113</FONT>       * @param bucketSize The interval of time (in minutes) in which data should be retrieved from<a name="line.113"></a>
<FONT color="green">114</FONT>       *          the server.<a name="line.114"></a>
<FONT color="green">115</FONT>       * @throws SensorBaseClientException Thrown if there is an error while communication with the<a name="line.115"></a>
<FONT color="green">116</FONT>       *           sensorbase server.<a name="line.116"></a>
<FONT color="green">117</FONT>       */<a name="line.117"></a>
<FONT color="green">118</FONT>      public SensorDataSnapshot(SensorBaseClient client, String user, String project, String sdt,<a name="line.118"></a>
<FONT color="green">119</FONT>          Day day, int bucketSize) throws SensorBaseClientException {<a name="line.119"></a>
<FONT color="green">120</FONT>        this.bucketSize = bucketSize;<a name="line.120"></a>
<FONT color="green">121</FONT>        this.setUpStartEndDay(day);<a name="line.121"></a>
<FONT color="green">122</FONT>        this.createLatestSnapshot(client, user, project, sdt);<a name="line.122"></a>
<FONT color="green">123</FONT>      }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>      /**<a name="line.125"></a>
<FONT color="green">126</FONT>       * Creates a new snapshot.<a name="line.126"></a>
<FONT color="green">127</FONT>       * <a name="line.127"></a>
<FONT color="green">128</FONT>       * @param client The &lt;code&gt;SensorBaseClient&lt;/code&gt; to be used for querying for<a name="line.128"></a>
<FONT color="green">129</FONT>       *          &lt;code&gt;SensorData&lt;/code&gt;.<a name="line.129"></a>
<FONT color="green">130</FONT>       * @param user The Hackystat user that owns the Project whose data is being retrieved.<a name="line.130"></a>
<FONT color="green">131</FONT>       * @param project The project to obtain data for.<a name="line.131"></a>
<FONT color="green">132</FONT>       * @param sdt The sensor data type to get data for.<a name="line.132"></a>
<FONT color="green">133</FONT>       * @param day The day to get the latest snapshot for.<a name="line.133"></a>
<FONT color="green">134</FONT>       * @param bucketSize The interval of time (in minutes) in which data should be retrieved from<a name="line.134"></a>
<FONT color="green">135</FONT>       *          the server.<a name="line.135"></a>
<FONT color="green">136</FONT>       * @param tool The tool that data should be retrieved for.<a name="line.136"></a>
<FONT color="green">137</FONT>       * @throws SensorBaseClientException Thrown if there is an error while communication with the<a name="line.137"></a>
<FONT color="green">138</FONT>       *           sensorbase server.<a name="line.138"></a>
<FONT color="green">139</FONT>       */<a name="line.139"></a>
<FONT color="green">140</FONT>      public SensorDataSnapshot(SensorBaseClient client, String user, String project, String sdt,<a name="line.140"></a>
<FONT color="green">141</FONT>          Day day, int bucketSize, String tool) throws SensorBaseClientException {<a name="line.141"></a>
<FONT color="green">142</FONT>        this.bucketSize = bucketSize;<a name="line.142"></a>
<FONT color="green">143</FONT>        this.setUpStartEndDay(day);<a name="line.143"></a>
<FONT color="green">144</FONT>        this.createLatestToolSnapshot(client, user, project, sdt, tool);<a name="line.144"></a>
<FONT color="green">145</FONT>      }<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>      /**<a name="line.147"></a>
<FONT color="green">148</FONT>       * Sets up the start and end day time variables used by the snapshot.<a name="line.148"></a>
<FONT color="green">149</FONT>       * <a name="line.149"></a>
<FONT color="green">150</FONT>       * @param day The day to use at when setting the start and end of day.<a name="line.150"></a>
<FONT color="green">151</FONT>       */<a name="line.151"></a>
<FONT color="green">152</FONT>      private void setUpStartEndDay(Day day) {<a name="line.152"></a>
<FONT color="green">153</FONT>        long lastTickOfTheDay = day.getLastTickOfTheDay();<a name="line.153"></a>
<FONT color="green">154</FONT>        long firstTickOfTheDay = day.getFirstTickOfTheDay();<a name="line.154"></a>
<FONT color="green">155</FONT>        this.startOfDay = Tstamp.makeTimestamp(firstTickOfTheDay);<a name="line.155"></a>
<FONT color="green">156</FONT>        this.endOfDay = Tstamp.makeTimestamp(lastTickOfTheDay);<a name="line.156"></a>
<FONT color="green">157</FONT>      }<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>      /**<a name="line.159"></a>
<FONT color="green">160</FONT>       * Iterates over intervals of time and queries the server for sensordata to create the latest<a name="line.160"></a>
<FONT color="green">161</FONT>       * snapshot for the specified tool.<a name="line.161"></a>
<FONT color="green">162</FONT>       * <a name="line.162"></a>
<FONT color="green">163</FONT>       * @param client The &lt;code&gt;SensorBaseClient&lt;/code&gt; to be used for querying for<a name="line.163"></a>
<FONT color="green">164</FONT>       *          &lt;code&gt;SensorData&lt;/code&gt;.<a name="line.164"></a>
<FONT color="green">165</FONT>       * @param user The Hackystat user to obtain data for.<a name="line.165"></a>
<FONT color="green">166</FONT>       * @param project The project to obtain data for.<a name="line.166"></a>
<FONT color="green">167</FONT>       * @param sdt The sensor data type to get data for.<a name="line.167"></a>
<FONT color="green">168</FONT>       * @param tool The tool that the snapshot is for.<a name="line.168"></a>
<FONT color="green">169</FONT>       * @throws SensorBaseClientException Thrown if there is an error while communication with the<a name="line.169"></a>
<FONT color="green">170</FONT>       *           sensorbase server.<a name="line.170"></a>
<FONT color="green">171</FONT>       */<a name="line.171"></a>
<FONT color="green">172</FONT>      private void createLatestToolSnapshot(SensorBaseClient client, String user, String project,<a name="line.172"></a>
<FONT color="green">173</FONT>          String sdt, String tool) throws SensorBaseClientException {<a name="line.173"></a>
<FONT color="green">174</FONT>        SnapshotBucket bucket = this.getNextBucket();<a name="line.174"></a>
<FONT color="green">175</FONT>    <a name="line.175"></a>
<FONT color="green">176</FONT>        // stop checking if older data is seen, or if<a name="line.176"></a>
<FONT color="green">177</FONT>        // bucket becomes null when the entire day has been iterated through<a name="line.177"></a>
<FONT color="green">178</FONT>        while (!this.seenOlderData &amp;&amp; bucket != null) {<a name="line.178"></a>
<FONT color="green">179</FONT>          <a name="line.179"></a>
<FONT color="green">180</FONT>          SensorDataIndex index = client.getProjectSensorData(user, project,<a name="line.180"></a>
<FONT color="green">181</FONT>              bucket.getStartTime(), bucket.getEndTime(), sdt);<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>          List&lt;SensorDataRef&gt; sensorDataRefList = index.getSensorDataRef();<a name="line.183"></a>
<FONT color="green">184</FONT>          // sort the list by timestamps, newest first<a name="line.184"></a>
<FONT color="green">185</FONT>          Collections.sort(sensorDataRefList, new SensorDataRefComparator(false));<a name="line.185"></a>
<FONT color="green">186</FONT>          for (SensorDataRef sensorDataRef : sensorDataRefList) {<a name="line.186"></a>
<FONT color="green">187</FONT>            if (this.seenOlderData) {<a name="line.187"></a>
<FONT color="green">188</FONT>              // stop iterating, older data found<a name="line.188"></a>
<FONT color="green">189</FONT>              break;<a name="line.189"></a>
<FONT color="green">190</FONT>            }<a name="line.190"></a>
<FONT color="green">191</FONT>            else {<a name="line.191"></a>
<FONT color="green">192</FONT>              SensorData sensorData = client.getSensorData(sensorDataRef);<a name="line.192"></a>
<FONT color="green">193</FONT>              // check that the data is for the correct tool<a name="line.193"></a>
<FONT color="green">194</FONT>              if (sensorData.getTool().equals(tool)) {<a name="line.194"></a>
<FONT color="green">195</FONT>                // tool matches, try to add the data<a name="line.195"></a>
<FONT color="green">196</FONT>                this.addData(sensorData);<a name="line.196"></a>
<FONT color="green">197</FONT>              }<a name="line.197"></a>
<FONT color="green">198</FONT>            }<a name="line.198"></a>
<FONT color="green">199</FONT>          }<a name="line.199"></a>
<FONT color="green">200</FONT>          bucket = this.getNextBucket();<a name="line.200"></a>
<FONT color="green">201</FONT>        }<a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>      }<a name="line.203"></a>
<FONT color="green">204</FONT>    <a name="line.204"></a>
<FONT color="green">205</FONT>      /**<a name="line.205"></a>
<FONT color="green">206</FONT>       * Iterates over intervals of time and queries the server for sensordata to create the<a name="line.206"></a>
<FONT color="green">207</FONT>       * snapshot.<a name="line.207"></a>
<FONT color="green">208</FONT>       * <a name="line.208"></a>
<FONT color="green">209</FONT>       * @param client The &lt;code&gt;SensorBaseClient&lt;/code&gt; to be used for querying for<a name="line.209"></a>
<FONT color="green">210</FONT>       *          &lt;code&gt;SensorData&lt;/code&gt;.<a name="line.210"></a>
<FONT color="green">211</FONT>       * @param user The Hackystat user to obtain data for.<a name="line.211"></a>
<FONT color="green">212</FONT>       * @param project The project to obtain data for.<a name="line.212"></a>
<FONT color="green">213</FONT>       * @param sdt The sensor data type to get data for.<a name="line.213"></a>
<FONT color="green">214</FONT>       * @throws SensorBaseClientException Thrown if there is an error while communication with the<a name="line.214"></a>
<FONT color="green">215</FONT>       *           sensorbase server.<a name="line.215"></a>
<FONT color="green">216</FONT>       */<a name="line.216"></a>
<FONT color="green">217</FONT>      private void createLatestSnapshot(SensorBaseClient client, String user, String project,<a name="line.217"></a>
<FONT color="green">218</FONT>          String sdt) throws SensorBaseClientException {<a name="line.218"></a>
<FONT color="green">219</FONT>    <a name="line.219"></a>
<FONT color="green">220</FONT>        SnapshotBucket bucket = this.getNextBucket();<a name="line.220"></a>
<FONT color="green">221</FONT>    <a name="line.221"></a>
<FONT color="green">222</FONT>        // stop checking if older data is seen, or if<a name="line.222"></a>
<FONT color="green">223</FONT>        // bucket becomes null when the entire day has been iterated through<a name="line.223"></a>
<FONT color="green">224</FONT>        while (!this.seenOlderData &amp;&amp; bucket != null) {<a name="line.224"></a>
<FONT color="green">225</FONT>          SensorDataIndex index = client.getProjectSensorData(user, project,<a name="line.225"></a>
<FONT color="green">226</FONT>              bucket.getStartTime(), bucket.getEndTime(), sdt);<a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>          List&lt;SensorDataRef&gt; sensorDataRefList = index.getSensorDataRef();<a name="line.228"></a>
<FONT color="green">229</FONT>          // sort the list by timestamps, newest first<a name="line.229"></a>
<FONT color="green">230</FONT>          Collections.sort(sensorDataRefList, new SensorDataRefComparator(false));<a name="line.230"></a>
<FONT color="green">231</FONT>          for (SensorDataRef sensorDataRef : sensorDataRefList) {<a name="line.231"></a>
<FONT color="green">232</FONT>            if (this.seenOlderData) {<a name="line.232"></a>
<FONT color="green">233</FONT>              // stop iterating, older data found<a name="line.233"></a>
<FONT color="green">234</FONT>              break;<a name="line.234"></a>
<FONT color="green">235</FONT>            }<a name="line.235"></a>
<FONT color="green">236</FONT>            else {<a name="line.236"></a>
<FONT color="green">237</FONT>              SensorData sensorData = client.getSensorData(sensorDataRef);<a name="line.237"></a>
<FONT color="green">238</FONT>              this.addData(sensorData);<a name="line.238"></a>
<FONT color="green">239</FONT>            }<a name="line.239"></a>
<FONT color="green">240</FONT>          }<a name="line.240"></a>
<FONT color="green">241</FONT>          if (!this.seenOlderData) {<a name="line.241"></a>
<FONT color="green">242</FONT>            bucket = this.getNextBucket();<a name="line.242"></a>
<FONT color="green">243</FONT>          }<a name="line.243"></a>
<FONT color="green">244</FONT>        }<a name="line.244"></a>
<FONT color="green">245</FONT>      }<a name="line.245"></a>
<FONT color="green">246</FONT>    <a name="line.246"></a>
<FONT color="green">247</FONT>      /**<a name="line.247"></a>
<FONT color="green">248</FONT>       * Gets the next bucket of time that should be checked for sensor data.<a name="line.248"></a>
<FONT color="green">249</FONT>       * <a name="line.249"></a>
<FONT color="green">250</FONT>       * @return Returns the next snapshot bucket or null if all buckets of time for the given day<a name="line.250"></a>
<FONT color="green">251</FONT>       *         have been checked.<a name="line.251"></a>
<FONT color="green">252</FONT>       */<a name="line.252"></a>
<FONT color="green">253</FONT>      private SnapshotBucket getNextBucket() {<a name="line.253"></a>
<FONT color="green">254</FONT>        if (this.prevBucket == null) {<a name="line.254"></a>
<FONT color="green">255</FONT>          // return first bucket, which starts at the end of the day<a name="line.255"></a>
<FONT color="green">256</FONT>          XMLGregorianCalendar startTime = this.getStartTime(this.endOfDay);<a name="line.256"></a>
<FONT color="green">257</FONT>          SnapshotBucket snapshotBucket = new SnapshotBucket(startTime, this.endOfDay);<a name="line.257"></a>
<FONT color="green">258</FONT>          this.prevBucket = snapshotBucket;<a name="line.258"></a>
<FONT color="green">259</FONT>          this.bucketsRetrieved++;<a name="line.259"></a>
<FONT color="green">260</FONT>          return snapshotBucket;<a name="line.260"></a>
<FONT color="green">261</FONT>        }<a name="line.261"></a>
<FONT color="green">262</FONT>        else if (this.prevBucket.getStartTime().compare(this.startOfDay) == DatatypeConstants.GREATER) {<a name="line.262"></a>
<FONT color="green">263</FONT>          // previous bucket did not start at the beginning of the day so,<a name="line.263"></a>
<FONT color="green">264</FONT>          // more buckets can still be obtained<a name="line.264"></a>
<FONT color="green">265</FONT>          // decrement old start time by 1 millisecond to prevent overlap<a name="line.265"></a>
<FONT color="green">266</FONT>          XMLGregorianCalendar newEndTime = Tstamp.incrementMilliseconds(<a name="line.266"></a>
<FONT color="green">267</FONT>              this.prevBucket.getStartTime(), -1);<a name="line.267"></a>
<FONT color="green">268</FONT>          XMLGregorianCalendar newStartTime = this.getStartTime(newEndTime);<a name="line.268"></a>
<FONT color="green">269</FONT>    <a name="line.269"></a>
<FONT color="green">270</FONT>          SnapshotBucket snapshotBucket = new SnapshotBucket(newStartTime, newEndTime);<a name="line.270"></a>
<FONT color="green">271</FONT>          this.prevBucket = snapshotBucket;<a name="line.271"></a>
<FONT color="green">272</FONT>          this.bucketsRetrieved++;<a name="line.272"></a>
<FONT color="green">273</FONT>          return snapshotBucket;<a name="line.273"></a>
<FONT color="green">274</FONT>        }<a name="line.274"></a>
<FONT color="green">275</FONT>        // previous bucket started at the start of day so it was the last bucket<a name="line.275"></a>
<FONT color="green">276</FONT>        return null;<a name="line.276"></a>
<FONT color="green">277</FONT>      }<a name="line.277"></a>
<FONT color="green">278</FONT>    <a name="line.278"></a>
<FONT color="green">279</FONT>      /**<a name="line.279"></a>
<FONT color="green">280</FONT>       * Gets the start time for a bucket based on the end time of the bucket.<a name="line.280"></a>
<FONT color="green">281</FONT>       * <a name="line.281"></a>
<FONT color="green">282</FONT>       * @param bucketEnd The end time for the bucket.<a name="line.282"></a>
<FONT color="green">283</FONT>       * @return Returns the bucket end time minus the given bucket size or the start of the day if<a name="line.283"></a>
<FONT color="green">284</FONT>       *         subtracting the bucket size overshoots the beginning of the day.<a name="line.284"></a>
<FONT color="green">285</FONT>       */<a name="line.285"></a>
<FONT color="green">286</FONT>      private XMLGregorianCalendar getStartTime(XMLGregorianCalendar bucketEnd) {<a name="line.286"></a>
<FONT color="green">287</FONT>        XMLGregorianCalendar startTime = Tstamp.incrementMinutes(bucketEnd, -this.bucketSize);<a name="line.287"></a>
<FONT color="green">288</FONT>    <a name="line.288"></a>
<FONT color="green">289</FONT>        if (startTime.compare(this.startOfDay) == DatatypeConstants.LESSER) {<a name="line.289"></a>
<FONT color="green">290</FONT>          // calculated start time is before the start of the day<a name="line.290"></a>
<FONT color="green">291</FONT>          // set start time to the start of the day so the remaining data is still retrieved<a name="line.291"></a>
<FONT color="green">292</FONT>          startTime = this.startOfDay;<a name="line.292"></a>
<FONT color="green">293</FONT>        }<a name="line.293"></a>
<FONT color="green">294</FONT>        return startTime;<a name="line.294"></a>
<FONT color="green">295</FONT>      }<a name="line.295"></a>
<FONT color="green">296</FONT>    <a name="line.296"></a>
<FONT color="green">297</FONT>      /**<a name="line.297"></a>
<FONT color="green">298</FONT>       * Adds sensor data to the collection of sensor data only if the runtime is valid.<a name="line.298"></a>
<FONT color="green">299</FONT>       * <a name="line.299"></a>
<FONT color="green">300</FONT>       * @param data The data to be added to the sensor data collection if it meets all criteria.<a name="line.300"></a>
<FONT color="green">301</FONT>       */<a name="line.301"></a>
<FONT color="green">302</FONT>      private void addData(SensorData data) {<a name="line.302"></a>
<FONT color="green">303</FONT>        XMLGregorianCalendar runtime = data.getRuntime();<a name="line.303"></a>
<FONT color="green">304</FONT>    <a name="line.304"></a>
<FONT color="green">305</FONT>        if (this.snapshotRuntime == null) {<a name="line.305"></a>
<FONT color="green">306</FONT>          // first entry, use that runtime as the snapshot runtime<a name="line.306"></a>
<FONT color="green">307</FONT>          this.snapshotRuntime = runtime;<a name="line.307"></a>
<FONT color="green">308</FONT>        }<a name="line.308"></a>
<FONT color="green">309</FONT>    <a name="line.309"></a>
<FONT color="green">310</FONT>        if (runtime.compare(this.snapshotRuntime) == DatatypeConstants.LESSER) {<a name="line.310"></a>
<FONT color="green">311</FONT>          // new runtime is less than the snapshot runtime, this is older data<a name="line.311"></a>
<FONT color="green">312</FONT>          this.seenOlderData = true;<a name="line.312"></a>
<FONT color="green">313</FONT>        }<a name="line.313"></a>
<FONT color="green">314</FONT>        else {<a name="line.314"></a>
<FONT color="green">315</FONT>          this.latestSnapshot.add(data);<a name="line.315"></a>
<FONT color="green">316</FONT>        }<a name="line.316"></a>
<FONT color="green">317</FONT>      }<a name="line.317"></a>
<FONT color="green">318</FONT>    <a name="line.318"></a>
<FONT color="green">319</FONT>      /**<a name="line.319"></a>
<FONT color="green">320</FONT>       * Returns an iterator over the last &lt;code&gt;SensorData&lt;/code&gt; snapshot.<a name="line.320"></a>
<FONT color="green">321</FONT>       * <a name="line.321"></a>
<FONT color="green">322</FONT>       * @return Returns an iterator over the last &lt;code&gt;SensorData&lt;/code&gt; snapshot.<a name="line.322"></a>
<FONT color="green">323</FONT>       */<a name="line.323"></a>
<FONT color="green">324</FONT>      public Iterator&lt;SensorData&gt; iterator() {<a name="line.324"></a>
<FONT color="green">325</FONT>        return this.latestSnapshot.iterator();<a name="line.325"></a>
<FONT color="green">326</FONT>      }<a name="line.326"></a>
<FONT color="green">327</FONT>    <a name="line.327"></a>
<FONT color="green">328</FONT>      /**<a name="line.328"></a>
<FONT color="green">329</FONT>       * Returns the Owner responsible for the Snapshot data, or null if there is no Snapshot data.<a name="line.329"></a>
<FONT color="green">330</FONT>       * @return The owner, or null. <a name="line.330"></a>
<FONT color="green">331</FONT>       */<a name="line.331"></a>
<FONT color="green">332</FONT>      public String getOwner() {<a name="line.332"></a>
<FONT color="green">333</FONT>        for (SensorData data : this.latestSnapshot) {<a name="line.333"></a>
<FONT color="green">334</FONT>          return data.getOwner();<a name="line.334"></a>
<FONT color="green">335</FONT>        }<a name="line.335"></a>
<FONT color="green">336</FONT>        return null;<a name="line.336"></a>
<FONT color="green">337</FONT>      }<a name="line.337"></a>
<FONT color="green">338</FONT>    <a name="line.338"></a>
<FONT color="green">339</FONT>      /**<a name="line.339"></a>
<FONT color="green">340</FONT>       * Returns the Tool responsible for the Snapshot data, or null if there is no Snapshot data.<a name="line.340"></a>
<FONT color="green">341</FONT>       * @return The owner, or null. <a name="line.341"></a>
<FONT color="green">342</FONT>       */<a name="line.342"></a>
<FONT color="green">343</FONT>      public String getTool() {<a name="line.343"></a>
<FONT color="green">344</FONT>        for (SensorData data : this.latestSnapshot) {<a name="line.344"></a>
<FONT color="green">345</FONT>          return data.getTool();<a name="line.345"></a>
<FONT color="green">346</FONT>        }<a name="line.346"></a>
<FONT color="green">347</FONT>        return null;<a name="line.347"></a>
<FONT color="green">348</FONT>      }<a name="line.348"></a>
<FONT color="green">349</FONT>      <a name="line.349"></a>
<FONT color="green">350</FONT>      /**<a name="line.350"></a>
<FONT color="green">351</FONT>       * Returns true if the Snapshot contains no data. <a name="line.351"></a>
<FONT color="green">352</FONT>       * @return True if the Snapshot contains no data. <a name="line.352"></a>
<FONT color="green">353</FONT>       */<a name="line.353"></a>
<FONT color="green">354</FONT>      public boolean isEmpty() {<a name="line.354"></a>
<FONT color="green">355</FONT>        return this.latestSnapshot.isEmpty();<a name="line.355"></a>
<FONT color="green">356</FONT>      }<a name="line.356"></a>
<FONT color="green">357</FONT>      <a name="line.357"></a>
<FONT color="green">358</FONT>      /**<a name="line.358"></a>
<FONT color="green">359</FONT>       * Gets the number of buckets that were retrieved to create the snapshot. This method is only<a name="line.359"></a>
<FONT color="green">360</FONT>       * meant for testing purposes.<a name="line.360"></a>
<FONT color="green">361</FONT>       * <a name="line.361"></a>
<FONT color="green">362</FONT>       * @return Returns the number of buckets retrieved during snapshot creation.<a name="line.362"></a>
<FONT color="green">363</FONT>       */<a name="line.363"></a>
<FONT color="green">364</FONT>      int getNumberOfBucketsRetrieved() {<a name="line.364"></a>
<FONT color="green">365</FONT>        return this.bucketsRetrieved;<a name="line.365"></a>
<FONT color="green">366</FONT>      }<a name="line.366"></a>
<FONT color="green">367</FONT>    }<a name="line.367"></a>




























































</PRE>
</BODY>
</HTML>
